Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

50 documentation update to fill in introduction and usage #54

Merged

Conversation

arthur-lin1027
Copy link
Collaborator

I think I have the basic structure here, with updated documentation and some some notebooks that are "embedded" (i.e. just linked).

@arthur-lin1027 arthur-lin1027 linked an issue Dec 14, 2024 that may be closed by this pull request
@arthur-lin1027
Copy link
Collaborator Author

I think I will just add the AniSOAP JOSS paper to this PR too -- simple copy-paste.

@rosecers rosecers force-pushed the 50-documentation-update-to-fill-in-introduction-and-usage branch from 85ab318 to 2c5911c Compare January 8, 2025 19:15
docs/source/installation.rst Outdated Show resolved Hide resolved
docs/source/installation.rst Outdated Show resolved Hide resolved
docs/source/getting_started.rst Outdated Show resolved Hide resolved
descriptors by computing anisotrophy extensions.
suitable for machine learning use. This project aims to extend the popular Smooth Overlap of Atomic Positions (SOAP)
descriptors to coarse-grained systems consisting of aspherical particles
with anisotropic interactions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a graphic in the future -- can you make an issue for this?

@rosecers rosecers merged commit 6cdae62 into main Jan 16, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation Update to Fill In Introduction and Usage
3 participants